home *** CD-ROM | disk | FTP | other *** search
/ BCI NET / BCI NET Dec 94.iso / archives / applications / misc / timekeepdev.lha / TimeKeep-Dev / Doc.txt / TimeKeep-Dev.txt < prev   
Encoding:
Text File  |  1994-11-03  |  18.6 KB  |  603 lines
  1. TimeKeep-Dev Documentation
  2. ----------------------------------------------------------------------------
  3.                               TimeKeep-Dev
  4.                                v 94.Nov.03
  5.  
  6.    Description 
  7.  
  8.    Shareware                             Tutorial 
  9.  
  10.    Development and Testing               Gadgets 
  11.  
  12.    Installing                            Project Name Codes 
  13.    Starting   
  14.  
  15.    Configuration 
  16.  
  17.    Error Messages      
  18.    Future Enhancements                   Programming 
  19.    Known BUGS          
  20.  
  21.                                          Legalness  
  22.                                          Thank Yous 
  23.    New in this version 
  24.    Previous versions                                  Locating The Author 
  25.  
  26.  
  27.                   TimeKeep-Dev is a time-clock utility
  28.          for keeping track of time spent on project development.
  29. ============================================================================
  30. Description
  31. ----------------------------------------------------------------------------
  32. Description
  33. -----------
  34.  
  35. TimeKeep-Dev is a time-clock utility for keeping track of time spent on
  36. project development.
  37.  
  38. Projects and Modules can be defined and a time clock interface used to
  39. TimeIn and TimeOut on a selected Module.  TimeKeep-Dev will remember
  40. which Module is currently in progress and will select it automatically
  41. when the program is re-started.
  42. ============================================================================
  43. Shareware
  44. ----------------------------------------------------------------------------
  45. Shareware
  46. ---------
  47.  
  48. A great deal of time has been spent in the development of TimeKeep-Dev.
  49.  
  50. This version is partially SAVE disabled.  If you wish to receive a
  51. non-disabled version of TimeKeep-Dev, a Shareware fee of $15.00
  52. (CANADIAN) or more is required.  Shareware fees of $20.00 (CANADIAN) or
  53. more will receive the next version automatically, at no additional
  54. charge. See:  Locating The Author 
  55.  
  56. Your shareware payment helps to insure continued development of
  57. TimeKeep-Dev. See:  Future Enhancements 
  58. ============================================================================
  59. Development and Testing
  60. ----------------------------------------------------------------------------
  61. Development and Testing
  62. -----------------------
  63.  
  64. TimeKeep-Dev was developed on an Amiga 3000T/25MHz with 2 Meg CHIP / 10
  65. Meg FAST memory.
  66.  
  67. TimeKeep-Dev has been tested under Kickstart version 37.175, Workbench
  68. version 38.12.
  69. ============================================================================
  70. Installing
  71. ----------------------------------------------------------------------------
  72. Installing
  73. ----------
  74.  
  75. The following files should be contained in the same directory:
  76.  
  77.                             TimeKeep-Dev
  78.                             TimeKeep-Dev.info
  79.  
  80.  
  81. Sample Data files
  82. -----------------
  83.  
  84. The files contained in the "sample data" directory have been provided as
  85. examples of the output created by TimeKeep-Dev.  To test them, copy them
  86. into your S: directory and run TimeKeep-Dev.  These data files will also
  87. allow you to see how the registered version remembers the contents of the
  88. SoFar gadget to display the total hours:minutes spent on projects.
  89. ============================================================================
  90. Starting
  91. ----------------------------------------------------------------------------
  92. Starting
  93. --------
  94.  
  95. From Workbench, double-click on the TimeKeep-Dev icon.
  96. ============================================================================
  97. Configuration
  98. ----------------------------------------------------------------------------
  99. Configuration
  100. -------------
  101.  
  102. TimeKeep-Dev supports configuration through use of Workbench ToolTypes.
  103. If any options are not included as a ToolType, the stated defaults will
  104. be used.
  105.  
  106. ToolTypes can be typed in upper or lower case or any combination of the
  107. two.  To have a ToolType ignored surround it with brackets ( ).
  108.  
  109. For example:
  110.                             (ToolType=Value)
  111.  
  112.  
  113. Invalid settings and ToolTypes will be ignored.  In this case, the default
  114. values will be used.
  115.  
  116. The following configuration commands are supported:
  117.  
  118.   AutoProjectNameCode=
  119.     Description: If set to YES, TimeKeep-Dev will automatically create a
  120.                  Project Name Code using its built-in function, when
  121.                  adding a new Project.
  122.  
  123.                  See  Project Name Codes  for more information.
  124.  
  125.     Valid values: YES, NO
  126.  
  127.     Default: YES
  128.  
  129.     Example: AutoProjectNameCode=NO
  130.  
  131.  
  132.   BackFillColor=
  133.     Description: Sets the palette color to use when filling the
  134.                  background.  A value of -1 will disable the fill.
  135.                  Colors are numbered from 0 up.
  136.  
  137.                  For MagicWB users, a value of 4 is recommended.
  138.  
  139.                  TimeKeep-Dev's NewScreen is currently a 4 color screen,
  140.                  taking its palette from the Workbench.
  141.  
  142.     Valid values: -1, 0...(nColors-1)
  143.  
  144.     Default: -1
  145.  
  146.     Example: BackFillColor=4
  147.  
  148.  
  149.   Database=
  150.     Description: This is the FULL PATH and FILENAME of the data file
  151.                  created by TimeKeep-Dev.  This file is where
  152.                  TimeKeep-Dev stores Project and Module information.
  153.  
  154.     Default: "S:TimeKeep-Dev.data"
  155.  
  156.     Example: Database="DATA:ScotwareSoftware/.TimeKeep-Dev.data"
  157.  
  158.  
  159.   DataPath=
  160.     Description: This is the FULL PATH to where TimeKeep-Dev will create
  161.                  its .time files.  These files contain TimeIn and TimeOut
  162.                  information for generating invoices.
  163.  
  164.     Default: "S:TimeKeep-Dev"
  165.  
  166.     Example: DataPath="DATA:ScotwareSoftware/.TimeKeep-Dev"
  167.  
  168.  
  169.   DefaultModule=
  170.  
  171.     Description: This is the text to be used as the name of the default
  172.                  Module.  When a new Project is added, a default Module
  173.                  is automatically created.
  174.  
  175.     Default: "General"
  176.  
  177.     Example: DefaultModule="Miscellaneous"
  178.  
  179.  
  180.   Font=
  181.     Description: This is the name of an 8 point font to be used within
  182.                  TimeKeep-Dev.  Currently, only 8 point Proportional or
  183.                  Non-Proportional fonts are supported.
  184.  
  185.                  TimeKeep-Dev will use the Default System Font,
  186.                  regardless of size, for the window title bar, if opened
  187.                  on the Default Public Screen.  If you use a really large
  188.                  Default System Font, you may have problems with the
  189.                  error message display.  If this is a problem for you,
  190.                  try using the NewScreen option, and the Font option to
  191.                  set a smaller font.
  192.  
  193.     Valid values: Any 8 point, Proportional or Non-Proportional font.
  194.  
  195.     Default: "topaz.font"
  196.  
  197.     Example: Font="Topaz2p"
  198.  
  199.  
  200.   NewScreen=
  201.     Description: If set to YES, TimeKeep-Dev will open on its own Public
  202.                  Screen.
  203.  
  204.                  If set to NO, TimeKeep-Dev will open on the default
  205.                  Public Screen.
  206.  
  207.     Valid values: YES, NO
  208.  
  209.     Default: NO
  210.  
  211.     Example: NewScreen=YES
  212. ============================================================================
  213. Error Messages
  214. ----------------------------------------------------------------------------
  215. Error Messages
  216. --------------
  217.  
  218. Could Not Create Gadgets
  219.  
  220. - TimeKeep-Dev was not able to create its gadgets.
  221.  
  222. Could Not Lock Screen
  223.  
  224. - TimeKeep-Dev could not get a lock on a default public screen, or could
  225.   not get visual information from it.  TimeKeep-Dev may not have been
  226.   able to find Workbench or another public screen to open on.
  227.  
  228. Could Not Open Font
  229.  
  230. - TimeKeep-Dev was not able to locate, or open the requested font as an 8
  231.   point font.
  232.  
  233. Could Not Open Screen
  234.  
  235. - TimeKeep-Dev was not able to open its own screen.
  236.  
  237. Could Not Open Window
  238.  
  239. - TimeKeep-Dev was not able to open its window.
  240.  
  241. Insufficient Memory
  242.  
  243. - TimeKeep-Dev could not allocate memory to create its structures and
  244.   lists.
  245.  
  246.  
  247. ERROR: Project Exists
  248.  
  249. - The Project Name already exists.  There can not be two Projects with the
  250.   same name.
  251.  
  252. ERROR: Default Module can not be edited
  253.  
  254. - The name of the Default Module can not be edited.  It can only be set
  255.   globally using the DefaultModule Tooltype.
  256.  
  257. ERROR: Insufficient Memory
  258.  
  259. - There was not enough memory to perform the requested function.
  260.  
  261. ERROR: Invalid Project Code
  262.  
  263. - The Project Code already exists or has not been confirmed by pressing
  264.   ENTER within the Code gadget.  There can not be two Projects with the
  265.   same Project code.
  266.  
  267. ERROR: Module Exists
  268.  
  269. - The Module Name already exists.  There can not be two Modules with the
  270.   same name.
  271. ============================================================================
  272. Tutorial
  273. ----------------------------------------------------------------------------
  274. Tutorial
  275. --------
  276.  
  277. This tutorial will single-step you through the normal operation of
  278. TimeKeep-Dev.
  279.  
  280. The assumption is made that you have not changed any of the defaults
  281. through use of ToolTypes.
  282.  
  283.  
  284. ADDING A NEW PROJECT
  285. ====================
  286.  
  287. · Start TimeKeep-Dev by Double-Clicking on its icon.
  288.  
  289. When you use TimeKeep-Dev for the very first time, the only gadget that
  290. will be selectable is the ADD gadget, under the Project list requester.
  291. If data had already been entered into TimeKeep-Dev, that data would now
  292. be displayed.
  293.  
  294. · Left-click on the ADD gadget under the Project list requester.
  295.  
  296. The Project Name string gadget is auto-selected.
  297.  
  298. · Type 'Test Number 1' {ENTER}
  299.  
  300. If you wish to abort ADDing, at any time click on the DELETE gadget.
  301.  
  302. The code 'TN1' is automatically entered into the CODE: string gadget and
  303. the gadget is auto-selected.
  304.  
  305. If the auto-created Code is satisfactory, just press {ENTER}.  If you
  306. wish to alter it, you may do so.  If you have set AutoProjectNameCode to
  307. NO, the gadget will be empty, and you must enter a Code.  We will change
  308. the default Code...
  309.  
  310. · Type 'TN1' {ENTER}
  311.  
  312. The gadget should now contain 'TN1TN1'.
  313.  
  314. 'Test Number 1' will now be added to the Project List and the default
  315. Module 'General' will be added to the Module List.
  316.  
  317.  
  318. ADDING A NEW MODULE
  319. ===================
  320.  
  321. · Left-Click on the ADD gadget, under the Module List.
  322.  
  323. The Module Name string gadget is auto-selected.
  324.  
  325. · Type 'Module 2' {ENTER}
  326.  
  327. If you wish to abort ADDing, at any time click on the DELETE gadget.
  328.  
  329. 'Module 2' will now be added to the Module List.
  330.  
  331.  
  332. KEEPING TRACK OF TIME
  333. =====================
  334.  
  335. When you are ready to start/continue work on a Module, all you have to
  336. do is select the Module (or add a new Module) and TimeIn.
  337.  
  338. · Left-Click on the Time In gadget
  339.  
  340. The current time will appear in the Time In string gadget.  If the Date
  341. and Time are satisfactory, you may continue.  If you wish to make changes
  342. you may do so by selecting the Date or Time string gadget and making
  343. changes followed by {ENTER}.
  344.  
  345.  
  346. TIMING-OUT OF A MODULE IN PROGRESS
  347. ==================================
  348.  
  349. When you have already started a Module using Time In, that Module will be
  350. remembered the next time you start TimeKeep-Dev, and will be
  351. automatically selected.
  352.  
  353. If we were Exiting and Re-starting TimeKeep-Dev, the 'Module 2' Module
  354. would be automatically selected since it now has a TimeIn.
  355.  
  356. · Left-Click on the Time Out gadget
  357.  
  358. The current time will appear in the Time Out string gadget.  If the Time
  359. is satisfactory, you may continue.  If you wish to make changes you may
  360. do so by selecting the Time Out string gadget and make changes followed
  361. by {ENTER}.
  362.  
  363. TimeKeep-Dev does not allow time to be carried on over 24 hours.  For
  364. this reason, changing the information in the Date string will change the
  365. Date for both Time In and Time Out.
  366.  
  367.  
  368. QUITTING
  369. ========
  370.  
  371. If you wish to save any changes you have made, you should click on SAVE
  372. or SAVE & QUIT.
  373.  
  374. · Left-Click on the QUIT gadget.
  375.  
  376.  
  377. END OF TUTORIAL
  378. ===============
  379. For further information about the use of TimeKeep-Dev see the  Gadgets 
  380. section.
  381. ============================================================================
  382. Gadgets
  383. ----------------------------------------------------------------------------
  384. Gadgets
  385. -------
  386.  
  387. So Far:
  388. -------
  389.   This gadget displays the hours and minutes of time spent on Modules
  390.   for the currently selected Project.  It is calculated as:
  391.  
  392.                   <TimeOut> - <TimeIn> + <CurrentValue>
  393.  
  394.   The following information may also be appear:
  395.  
  396.        ??????       The amount is unknown at this time.
  397.        ------       The amount has been altered, but not saved yet.
  398.  
  399.  
  400. Code:
  401. -----
  402.   This gadget displays the current Project Name Code.
  403.  
  404.   If the AutoProjectNameCode tooltype is activated, pressing 'HELP' within
  405.   this gadget will re-invoke the builtin feature.  This can be useful if
  406.   you accidentally change the contents of this gadget and are not
  407.   familiar with the method used to determine the Project Name Code.  If
  408.   AutoProjectNameCode is not activated, pressing 'HELP' will clear this
  409.   gadget.
  410. ============================================================================
  411. Project Name Codes
  412. ----------------------------------------------------------------------------
  413. Project Name Codes
  414. ------------------
  415.  
  416. Project Name Codes can be a maximum of 6 characters long.
  417.  
  418. TimeKeep-Dev has a built-in function to automatically create Project Name
  419. Codes.  At present, it simply combines the first letter of each word in
  420. the Project name.
  421.  
  422. If you have a method of creating Name Codes that you would like to see
  423. supported, contact the author.  See:  Locating The Author 
  424.  
  425. This feature can be enabled or disabled using the AutoProjectNameCode
  426. ToolType.
  427.  
  428.  
  429. Applicable Configuration Commands:
  430.  
  431.                             AutoProjectNameCode 
  432. ============================================================================
  433. Programming
  434. ----------------------------------------------------------------------------
  435. Programming
  436. -----------
  437.  
  438. If you write your own TimeKeep-Dev utility for any other software, please
  439. send a copy to the author for inclusion with this distribution.
  440. See:  Locating The Author 
  441.  
  442.  
  443. .time File Format
  444. -----------------
  445.  
  446. This is the format of the .time data file created by TimeKeep-Dev.
  447.  
  448. LINE 1:
  449.                    "<ProjectNameCode>","<ProjectName>"
  450.  
  451.   example:
  452.                         "TEST1","This is Test #1"
  453.  
  454.  
  455. LINE 2...n:
  456.  
  457.    "T","<Module>","<DateIn>","<TimeIn>","<TimeOut>",<Hours>,<Minutes>
  458.  
  459.   where:
  460.  
  461.   "T" = Time Information
  462.  
  463.      <Module>  = Module name
  464.      <DateIn>  = Time In date
  465.      <TimeIn>  = Time In time
  466.      <TimeOut> = Time Out time
  467.      <Hours>   = TimeOut - TimeIn (hours)
  468.      <Minutes> = TimeOut - TimeIn (minutess)
  469.  
  470.   examples:
  471.  
  472.          "T","Test Module","May 16","12:15 PM","1:00 PM", 0, 45
  473. ============================================================================
  474. Legalness
  475. ----------------------------------------------------------------------------
  476. Legalness
  477. ---------
  478.  
  479. TimeKeep-Dev is copyright ©1994 by Scotware\Software.  With the exception
  480. of the ARexx utilities, the files included with this distribution may not
  481. be altered in any way.  TimeKeep-Dev is released as Shareware - You are
  482. required to pay a  Shareware  fee if you continue to use this software
  483. beyond a trial period of 10 days.
  484.  
  485. The software concept and design remain the property of the author,
  486. scott dhomas trenn and Scotware\Software.
  487.  
  488. Permission is granted for this program to appear in any public domain
  489. software archives.
  490.  
  491. Permission is granted for this program to appear on any commercial disks
  492. or CDROMs, provided that a single copy of the first product, containing
  493. this version of this progam, is sent to the author.
  494.  
  495. The author is in no way liable for any damage resulting from the use of
  496. this program.
  497. ============================================================================
  498. Future Enhancements
  499. ----------------------------------------------------------------------------
  500. Future Enhancements
  501. -------------------
  502.  
  503. -  Nettwork support, Multi-user
  504. -  Larger font support
  505. -  Definable Project Code function
  506. -  Busy pointer
  507. -  Select InProgress button gadget
  508. -  Cancel TimeIn/TimeOut button gadgets
  509. -  Runnable from CLI
  510. -  and MORE...
  511. ============================================================================
  512. Known BUGS
  513. ----------------------------------------------------------------------------
  514. Known BUGS
  515. ----------
  516.  
  517. - In Progress counter is not completely working.
  518. ============================================================================
  519. Locating The Author
  520. ----------------------------------------------------------------------------
  521. Locating The Author
  522. -------------------
  523.  
  524. If you like this program and would like to register, reward me for my
  525. efforts, or for bug reports, program ideas, or questions, or just to tell
  526. me about where you live.
  527.  
  528. I can be contacted through INTERNET EMAIL at:
  529.  
  530.                               dhomas@unb.ca
  531.  
  532.                                  - OR -
  533.  
  534.                       dhomas@jupiter.sun.csd.unb.ca
  535.  
  536. Or by MAIL at:
  537.                             scott dhomas trenn
  538.                             Scotware\Software
  539.                            797 Mitchell Street
  540.                              Fredericton, NB
  541.                              CANADA  E3B 3S8
  542.  
  543.  
  544. Registered users may send me $5.00 (CANADIAN) and a disk, for the latest
  545. version of this software.
  546.  
  547. Be sure to include the version number you are currently using, and the
  548. name of the program you want, so I do not send you a version you already
  549. have or a program you do not want.  The version number can be found in the
  550. titlebar, at the top of this documentation file, or by typing:
  551.  
  552.                           Version TimeKeep-Dev
  553.  
  554. at a shell prompt.  It looks similar to     94.Oct.16
  555.  
  556. When reporting bugs or errors generated when you run TimeKeep-Dev, please
  557. include any error messages given by TimeKeep-Dev and also the version
  558. number you are using.  This will aid me in tracking down the problem.
  559. Thank-you.
  560.  
  561. If you have an EMAIL address please include that with your letter.
  562. ============================================================================
  563. Thank Yous
  564. ----------------------------------------------------------------------------
  565. Thank Yous
  566. ----------
  567.  
  568. Thanks to the following people for beta-testing, suggestions, bug reports
  569. and support:
  570.  
  571. - None yet       - No City, No Country
  572.  
  573.                                                             - dhomas trenn
  574. ============================================================================
  575. New in this version
  576. ----------------------------------------------------------------------------
  577. New In This Version
  578. -------------------
  579.  
  580. - Fixed an Uneven Address Error which caused a GURU (#8000 0003) on
  581.   68000/68010 CPUs.
  582.  
  583. - Changed icon shadow from blue to dark grey.
  584. ============================================================================
  585. Previous versions
  586. ----------------------------------------------------------------------------
  587. New In This 94.Oct.18
  588. ---------------------
  589.  
  590. - Modified UnRegistered version to allow partial saving.  This should make
  591.   it easier to decide if you want to get the full registered version.
  592.  
  593. - Added 'Cancel' TimeIn/TimeOut gadget.
  594.  
  595. - Background color is set to the BackFillColor tooltype setting, for
  596.   (Un)Registered text.
  597.  
  598. New In Version 94.Oct.16
  599. ------------------------
  600.  
  601. - First Release
  602. ============================================================================
  603.